Skip to main content
GET
/
agent
/
{agent_id}
Get Agent by ID
curl --request GET \
  --url https://agent-prod.studio.lyzr.ai/v2/agent/{agent_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "67e3aff94c4db47d2999cdef",
  "name": "Sample Agent",
  "description": "This is an example agent response"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET /v3/agents/{agent_id}

​
Authentication

  • Requires an API key (x-api-key) in the request headers.

​
Path Parameters

ParameterTypeDescription
agent_idstringUnique identifier of the agent to retrieve.

​
Request Example (cURL)

curl -X GET "https://agent-prod.studio.lyzr.ai/v3/agents/{agent_id}"
-H "accept: application/json" ^
-H "x-api-key: sk-default-REPLACED-API-KEY"

​
Response Example

{
  "agent_id": "67e21aecd0da0fb69fe95780",
  "name": "Finance Advisor",
  "description": "Personalized Financial Planning Assistant",
  "model": "gpt-4o-mini",
  "provider_id": "OpenAI",
  "features": [...]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
agent_id
string
required

The ID of the agent to retrieve.

Response

Agent retrieved successfully

​
id
string
Example:

"67e3aff94c4db47d2999cdef"

​
name
string
Example:

"Sample Agent"

​
description
string
Example:

"This is an example agent response"